//
//  firmware-defs.h
//  AppleIntelWiFiMVM
//
//  Created by Aaron Mulder on 2/13/16.
//  Copyright © 2016 Aaron Mulder. All rights reserved.
//

#ifndef firmware_defs_h
#define firmware_defs_h

#include "linux-porting.h"
#include "linux-80211.h"
#include "iwl-fw-error-dump.h"
//#include "iwl-trans.h"

#define IWL_DEBUG_INFO(drv, args...) IOLog(args)
#define IWL_ERR(drv, args...) IOLog(args)
#define IWL_INFO(drv, args...) IOLog(args)
#define IWL_DEBUG_FW(drv, args...) IOLog(args)
#define iwl_print_hex_dump(m, level, p, len) IOLog("%s Unable to print hex dump; see iwl-debug.h", "AppleIntelWiFiMVM")


// Bitwise int types
typedef unsigned int /*__bitwise__*/ iwl_ucode_tlv_api_t;
typedef unsigned int /*__bitwise__*/ iwl_ucode_tlv_capa_t;

// from uapi/linux/ethtool.h
#define ETHTOOL_FWVERS_LEN	32

/*
 * For 16.0 uCode and above, there is no differentiation between sections,
 * just an offset to the HW address.
 */
#define IWL_UCODE_SECTION_MAX 16
#define CPU1_CPU2_SEPARATOR_SECTION	0xFFFFCCCC
#define PAGING_SEPARATOR_SECTION	0xAAAABBBB

/* uCode version contains 4 values: Major/Minor/API/Serial */
#define IWL_UCODE_MAJOR(ver)	(((ver) & 0xFF000000) >> 24)
#define IWL_UCODE_MINOR(ver)	(((ver) & 0x00FF0000) >> 16)
#define IWL_UCODE_API(ver)	(((ver) & 0x0000FF00) >> 8)
#define IWL_UCODE_SERIAL(ver)	((ver) & 0x000000FF)

#define IWL_UCODE_MAX_CS		1
#define IWL_TLV_UCODE_MAGIC		0x0a4c5749

/* The default max probe length if not specified by the firmware file */
#define IWL_DEFAULT_MAX_PROBE_LENGTH	200

/* The default calibrate table size if not specified by firmware file */
#define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE	18
#define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE		19
#define IWL_MAX_PHY_CALIBRATE_TBL_SIZE			253

#define IWL_DEFAULT_SCAN_CHANNELS 40

#define UCODE_EXPERIMENTAL_INDEX	100
#define UCODE_EXPERIMENTAL_TAG		"exp"

#define FW_DBG_START_FROM_ALIVE	0
#define FW_DBG_CONF_MAX		32
#define FW_DBG_INVALID		0xff

/*
 * Block paging calculations
 */
#define PAGE_2_EXP_SIZE 12 /* 4K == 2^12 */
#define FW_PAGING_SIZE BIT(PAGE_2_EXP_SIZE) /* page size is 4KB */
#define PAGE_PER_GROUP_2_EXP_SIZE 3
/* 8 pages per group */
#define NUM_OF_PAGE_PER_GROUP BIT(PAGE_PER_GROUP_2_EXP_SIZE)
/* don't change, support only 32KB size */
#define PAGING_BLOCK_SIZE (NUM_OF_PAGE_PER_GROUP * FW_PAGING_SIZE)
/* 32K == 2^15 */
#define BLOCK_2_EXP_SIZE (PAGE_2_EXP_SIZE + PAGE_PER_GROUP_2_EXP_SIZE)

/*
 * Image paging calculations
 */
#define BLOCK_PER_IMAGE_2_EXP_SIZE 5
/* 2^5 == 32 blocks per image */
#define NUM_OF_BLOCK_PER_IMAGE BIT(BLOCK_PER_IMAGE_2_EXP_SIZE)
/* maximum image size 1024KB */
#define MAX_PAGING_IMAGE_SIZE (NUM_OF_BLOCK_PER_IMAGE * PAGING_BLOCK_SIZE)


/**
 * enum iwl_ucode_type
 *
 * The type of ucode.
 *
 * @IWL_UCODE_REGULAR: Normal runtime ucode
 * @IWL_UCODE_INIT: Initial ucode
 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
 * @IWL_UCODE_REGULAR_USNIFFER: Normal runtime ucode when using usniffer image
 */
enum iwl_ucode_type {
    IWL_UCODE_REGULAR,
    IWL_UCODE_INIT,
    IWL_UCODE_WOWLAN,
    IWL_UCODE_REGULAR_USNIFFER,
    IWL_UCODE_TYPE_MAX,
};

/*
 * enumeration of ucode section.
 * This enumeration is used directly for older firmware (before 16.0).
 * For new firmware, there can be up to 4 sections (see below) but the
 * first one packaged into the firmware file is the DATA section and
 * some debugging code accesses that.
 */
enum iwl_ucode_sec {
    IWL_UCODE_SECTION_DATA,
    IWL_UCODE_SECTION_INST,
};

/*
 * Calibration control struct.
 * Sent as part of the phy configuration command.
 * @flow_trigger: bitmap for which calibrations to perform according to
 *		flow triggers.
 * @event_trigger: bitmap for which calibrations to perform according to
 *		event triggers.
 */
#pragma pack(1)
struct iwl_tlv_calib_ctrl {
    __le32 flow_trigger;
    __le32 event_trigger;
} /*__packed*/;
#pragma options align=reset

/* one for each uCode image (inst/data, init/runtime/wowlan) */
struct fw_desc {
    void *data;	/* vmalloc'ed data */
    size_t len;		/* size in bytes */
    u32 offset;		/* offset in the device */
};


struct fw_img {
    struct fw_desc sec[IWL_UCODE_SECTION_MAX];
    bool is_dual_cpus;
    u32 paging_mem_size;
};

/**
 * enum iwl_ucode_tlv_capa - ucode capabilities
 * @IWL_UCODE_TLV_CAPA_D0I3_SUPPORT: supports D0i3
 * @IWL_UCODE_TLV_CAPA_LAR_SUPPORT: supports Location Aware Regulatory
 * @IWL_UCODE_TLV_CAPA_UMAC_SCAN: supports UMAC scan.
 * @IWL_UCODE_TLV_CAPA_BEAMFORMER: supports Beamformer
 * @IWL_UCODE_TLV_CAPA_TOF_SUPPORT: supports Time of Flight (802.11mc FTM)
 * @IWL_UCODE_TLV_CAPA_TDLS_SUPPORT: support basic TDLS functionality
 * @IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT: supports insertion of current
 *	tx power value into TPC Report action frame and Link Measurement Report
 *	action frame
 * @IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT: supports updating current
 *	channel in DS parameter set element in probe requests.
 * @IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT: supports adding TPC Report IE in
 *	probe requests.
 * @IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT: supports Quiet Period requests
 * @IWL_UCODE_TLV_CAPA_DQA_SUPPORT: supports dynamic queue allocation (DQA),
 *	which also implies support for the scheduler configuration command
 * @IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH: supports TDLS channel switching
 * @IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT: supports Hot Spot Command
 * @IWL_UCODE_TLV_CAPA_DC2DC_SUPPORT: supports DC2DC Command
 * @IWL_UCODE_TLV_CAPA_CSUM_SUPPORT: supports TCP Checksum Offload
 * @IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS: support radio and beacon statistics
 * @IWL_UCODE_TLV_CAPA_BT_COEX_PLCR: enabled BT Coex packet level co-running
 * @IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC: ucode supports LAR updates with different
 *	sources for the MCC. This TLV bit is a future replacement to
 *	IWL_UCODE_TLV_API_WIFI_MCC_UPDATE. When either is set, multi-source LAR
 *	is supported.
 * @IWL_UCODE_TLV_CAPA_BT_COEX_RRC: supports BT Coex RRC
 * @IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT: supports gscan
 * @IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE: extended DTS measurement
 * @IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS: supports short PM timeouts
 *
 * @NUM_IWL_UCODE_TLV_CAPA: number of bits used
 */
enum iwl_ucode_tlv_capa {
    IWL_UCODE_TLV_CAPA_D0I3_SUPPORT			= (/*__force__*/ iwl_ucode_tlv_capa_t)0,
    IWL_UCODE_TLV_CAPA_LAR_SUPPORT			= (/*__force__*/ iwl_ucode_tlv_capa_t)1,
    IWL_UCODE_TLV_CAPA_UMAC_SCAN			= (/*__force__*/ iwl_ucode_tlv_capa_t)2,
    IWL_UCODE_TLV_CAPA_BEAMFORMER			= (/*__force__*/ iwl_ucode_tlv_capa_t)3,
    IWL_UCODE_TLV_CAPA_TOF_SUPPORT                  = (/*__force__*/ iwl_ucode_tlv_capa_t)5,
    IWL_UCODE_TLV_CAPA_TDLS_SUPPORT			= (/*__force__*/ iwl_ucode_tlv_capa_t)6,
    IWL_UCODE_TLV_CAPA_TXPOWER_INSERTION_SUPPORT	= (/*__force__*/ iwl_ucode_tlv_capa_t)8,
    IWL_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT	= (/*__force__*/ iwl_ucode_tlv_capa_t)9,
    IWL_UCODE_TLV_CAPA_WFA_TPC_REP_IE_SUPPORT	= (/*__force__*/ iwl_ucode_tlv_capa_t)10,
    IWL_UCODE_TLV_CAPA_QUIET_PERIOD_SUPPORT		= (/*__force__*/ iwl_ucode_tlv_capa_t)11,
    IWL_UCODE_TLV_CAPA_DQA_SUPPORT			= (/*__force__*/ iwl_ucode_tlv_capa_t)12,
    IWL_UCODE_TLV_CAPA_TDLS_CHANNEL_SWITCH		= (/*__force__*/ iwl_ucode_tlv_capa_t)13,
    IWL_UCODE_TLV_CAPA_HOTSPOT_SUPPORT		= (/*__force__*/ iwl_ucode_tlv_capa_t)18,
    IWL_UCODE_TLV_CAPA_DC2DC_CONFIG_SUPPORT		= (/*__force__*/ iwl_ucode_tlv_capa_t)19,
    IWL_UCODE_TLV_CAPA_CSUM_SUPPORT			= (/*__force__*/ iwl_ucode_tlv_capa_t)21,
    IWL_UCODE_TLV_CAPA_RADIO_BEACON_STATS		= (/*__force__*/ iwl_ucode_tlv_capa_t)22,
    IWL_UCODE_TLV_CAPA_BT_COEX_PLCR			= (/*__force__*/ iwl_ucode_tlv_capa_t)28,
    IWL_UCODE_TLV_CAPA_LAR_MULTI_MCC		= (/*__force__*/ iwl_ucode_tlv_capa_t)29,
    IWL_UCODE_TLV_CAPA_BT_COEX_RRC			= (/*__force__*/ iwl_ucode_tlv_capa_t)30,
    IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT		= (/*__force__*/ iwl_ucode_tlv_capa_t)31,
    IWL_UCODE_TLV_CAPA_EXTENDED_DTS_MEASURE		= (/*__force__*/ iwl_ucode_tlv_capa_t)64,
    IWL_UCODE_TLV_CAPA_SHORT_PM_TIMEOUTS		= (/*__force__*/ iwl_ucode_tlv_capa_t)65,
    
    NUM_IWL_UCODE_TLV_CAPA
};


/**
 * enum iwl_ucode_tlv_api - ucode api
 * @IWL_UCODE_TLV_API_BT_COEX_SPLIT: new API for BT Coex
 * @IWL_UCODE_TLV_API_FRAGMENTED_SCAN: This ucode supports active dwell time
 *	longer than the passive one, which is essential for fragmented scan.
 * @IWL_UCODE_TLV_API_WIFI_MCC_UPDATE: ucode supports MCC updates with source.
 * @IWL_UCODE_TLV_API_WIDE_CMD_HDR: ucode supports wide command header
 * @IWL_UCODE_TLV_API_LQ_SS_PARAMS: Configure STBC/BFER via LQ CMD ss_params
 * @IWL_UCODE_TLV_API_NEW_VERSION: new versioning format
 * @IWL_UCODE_TLV_API_EXT_SCAN_PRIORITY: scan APIs use 8-level priority
 *	instead of 3.
 * @IWL_UCODE_TLV_API_TX_POWER_CHAIN: TX power API has larger command size
 *	(command version 3) that supports per-chain limits
 *
 * @NUM_IWL_UCODE_TLV_API: number of bits used
 */
enum iwl_ucode_tlv_api {
    IWL_UCODE_TLV_API_BT_COEX_SPLIT     = (/*__force*/ iwl_ucode_tlv_api_t)3,
    IWL_UCODE_TLV_API_FRAGMENTED_SCAN	= (/*__force*/ iwl_ucode_tlv_api_t)8,
    IWL_UCODE_TLV_API_WIFI_MCC_UPDATE	= (/*__force*/ iwl_ucode_tlv_api_t)9,
    IWL_UCODE_TLV_API_WIDE_CMD_HDR		= (/*__force*/ iwl_ucode_tlv_api_t)14,
    IWL_UCODE_TLV_API_LQ_SS_PARAMS		= (/*__force*/ iwl_ucode_tlv_api_t)18,
    IWL_UCODE_TLV_API_NEW_VERSION		= (/*__force*/ iwl_ucode_tlv_api_t)20,
    IWL_UCODE_TLV_API_EXT_SCAN_PRIORITY	= (/*__force*/ iwl_ucode_tlv_api_t)24,
    IWL_UCODE_TLV_API_TX_POWER_CHAIN	= (/*__force*/ iwl_ucode_tlv_api_t)27,
    
    NUM_IWL_UCODE_TLV_API
};

struct iwl_ucode_capabilities {
    u32 max_probe_length;
    u32 n_scan_channels;
    u32 standard_phy_calibration_size;
    u32 flags;
    unsigned long _api[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_API)];
    unsigned long _capa[BITS_TO_LONGS(NUM_IWL_UCODE_TLV_CAPA)];
};

/**
 * enum iwl_fw_dbg_monitor_mode - available monitor recording modes
 *
 * @SMEM_MODE: monitor stores the data in SMEM
 * @EXTERNAL_MODE: monitor stores the data in allocated DRAM
 * @MARBH_MODE: monitor stores the data in MARBH buffer
 * @MIPI_MODE: monitor outputs the data through the MIPI interface
 */
enum iwl_fw_dbg_monitor_mode {
    SMEM_MODE = 0,
    EXTERNAL_MODE = 1,
    MARBH_MODE = 2,
    MIPI_MODE = 3,
};

static inline bool
fw_has_api(const struct iwl_ucode_capabilities *capabilities,
           iwl_ucode_tlv_api_t api)
{
    return test_bit(/*(__force long)*/api, capabilities->_api);
}

static inline bool
fw_has_capa(const struct iwl_ucode_capabilities *capabilities,
            iwl_ucode_tlv_capa_t capa)
{
    return test_bit(/*(__force long)*/capa, capabilities->_capa);
}

static inline const char *get_fw_dbg_mode_string(int mode)
{
    switch (mode) {
        case SMEM_MODE:
            return "SMEM";
        case EXTERNAL_MODE:
            return "EXTERNAL_DRAM";
        case MARBH_MODE:
            return "MARBH";
        case MIPI_MODE:
            return "MIPI";
        default:
            return "UNKNOWN";
    }
}



/**
 * struct iwl_gscan_capabilities - gscan capabilities supported by FW
 * @max_scan_cache_size: total space allocated for scan results (in bytes).
 * @max_scan_buckets: maximum number of channel buckets.
 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
 * @max_hotlist_aps: maximum number of entries for hotlist APs.
 * @max_significant_change_aps: maximum number of entries for significant
 *	change APs.
 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
 *	hold.
 */
struct iwl_gscan_capabilities {
    u32 max_scan_cache_size;
    u32 max_scan_buckets;
    u32 max_ap_cache_per_scan;
    u32 max_rssi_sample_size;
    u32 max_scan_reporting_threshold;
    u32 max_hotlist_aps;
    u32 max_significant_change_aps;
    u32 max_bssid_history_entries;
};

/*
 * struct fw_sec: Just for the image parsing process.
 * For the fw storage we are using struct fw_desc.
 */
struct fw_sec {
    const void *data;		/* the sec data */
    size_t size;			/* section size */
    u32 offset;			/* offset of writing in the device */
};

struct fw_img_parsing {
    struct fw_sec sec[IWL_UCODE_SECTION_MAX];
    int sec_counter;
};

struct iwl_firmware_pieces {
    struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
    
    u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
    u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
    
    /* FW debug data parsed for driver usage */
    struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
    struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
    size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
    struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
    size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
};

/**
 * struct iwl_fw_dbg_reg_op - an operation on a register
 *
 * @op: %enum iwl_fw_dbg_reg_operator
 * @addr: offset of the register
 * @val: value
 */
#pragma pack(1)
struct iwl_fw_dbg_reg_op {
    u8 op;
    u8 reserved[3];
    __le32 addr;
    __le32 val;
};// __packed;

/**
 * struct iwl_fw_dbg_dest_tlv - configures the destination of the debug data
 *
 * @version: version of the TLV - currently 0
 * @monitor_mode: %enum iwl_fw_dbg_monitor_mode
 * @size_power: buffer size will be 2^(size_power + 11)
 * @base_reg: addr of the base addr register (PRPH)
 * @end_reg:  addr of the end addr register (PRPH)
 * @write_ptr_reg: the addr of the reg of the write pointer
 * @wrap_count: the addr of the reg of the wrap_count
 * @base_shift: shift right of the base addr reg
 * @end_shift: shift right of the end addr reg
 * @reg_ops: array of registers operations
 *
 * This parses IWL_UCODE_TLV_FW_DBG_DEST
 */
struct iwl_fw_dbg_dest_tlv {
    u8 version;
    u8 monitor_mode;
    u8 size_power;
    u8 reserved;
    __le32 base_reg;
    __le32 end_reg;
    __le32 write_ptr_reg;
    __le32 wrap_count;
    u8 base_shift;
    u8 end_shift;
    struct iwl_fw_dbg_reg_op reg_ops[0];
};// __packed;
#pragma options align=reset

#pragma pack(1)
struct iwl_fw_dbg_conf_hcmd {
    u8 id;
    u8 reserved;
    __le16 len;
    u8 data[0];
};// __packed;
#pragma options align=reset

/**
 * enum iwl_fw_dbg_trigger_mode - triggers functionalities
 *
 * @IWL_FW_DBG_TRIGGER_START: when trigger occurs re-conf the dbg mechanism
 * @IWL_FW_DBG_TRIGGER_STOP: when trigger occurs pull the dbg data
 * @IWL_FW_DBG_TRIGGER_MONITOR_ONLY: when trigger occurs trigger is set to
 *	collect only monitor data
 */
enum iwl_fw_dbg_trigger_mode {
    IWL_FW_DBG_TRIGGER_START = BIT(0),
    IWL_FW_DBG_TRIGGER_STOP = BIT(1),
    IWL_FW_DBG_TRIGGER_MONITOR_ONLY = BIT(2),
};

/**
 * enum iwl_fw_dbg_trigger_vif_type - define the VIF type for a trigger
 * @IWL_FW_DBG_CONF_VIF_ANY: any vif type
 * @IWL_FW_DBG_CONF_VIF_IBSS: IBSS mode
 * @IWL_FW_DBG_CONF_VIF_STATION: BSS mode
 * @IWL_FW_DBG_CONF_VIF_AP: AP mode
 * @IWL_FW_DBG_CONF_VIF_P2P_CLIENT: P2P Client mode
 * @IWL_FW_DBG_CONF_VIF_P2P_GO: P2P GO mode
 * @IWL_FW_DBG_CONF_VIF_P2P_DEVICE: P2P device
 */
enum iwl_fw_dbg_trigger_vif_type {
    IWL_FW_DBG_CONF_VIF_ANY = NL80211_IFTYPE_UNSPECIFIED,
    IWL_FW_DBG_CONF_VIF_IBSS = NL80211_IFTYPE_ADHOC,
    IWL_FW_DBG_CONF_VIF_STATION = NL80211_IFTYPE_STATION,
    IWL_FW_DBG_CONF_VIF_AP = NL80211_IFTYPE_AP,
    IWL_FW_DBG_CONF_VIF_P2P_CLIENT = NL80211_IFTYPE_P2P_CLIENT,
    IWL_FW_DBG_CONF_VIF_P2P_GO = NL80211_IFTYPE_P2P_GO,
    IWL_FW_DBG_CONF_VIF_P2P_DEVICE = NL80211_IFTYPE_P2P_DEVICE,
};

/**
 * struct iwl_fw_dbg_trigger_tlv - a TLV that describes the trigger
 * @id: %enum iwl_fw_dbg_trigger
 * @vif_type: %enum iwl_fw_dbg_trigger_vif_type
 * @stop_conf_ids: bitmap of configurations this trigger relates to.
 *	if the mode is %IWL_FW_DBG_TRIGGER_STOP, then if the bit corresponding
 *	to the currently running configuration is set, the data should be
 *	collected.
 * @stop_delay: how many milliseconds to wait before collecting the data
 *	after the STOP trigger fires.
 * @mode: %enum iwl_fw_dbg_trigger_mode - can be stop / start of both
 * @start_conf_id: if mode is %IWL_FW_DBG_TRIGGER_START, this defines what
 *	configuration should be applied when the triggers kicks in.
 * @occurrences: number of occurrences. 0 means the trigger will never fire.
 */
#pragma pack(1)
struct iwl_fw_dbg_trigger_tlv {
    __le32 id;
    __le32 vif_type;
    __le32 stop_conf_ids;
    __le32 stop_delay;
    u8 mode;
    u8 start_conf_id;
    __le16 occurrences;
    __le32 reserved[2];
    
    u8 data[0];
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_missed_bcon - configures trigger for missed beacons
 * @stop_consec_missed_bcon: stop recording if threshold is crossed.
 * @stop_consec_missed_bcon_since_rx: stop recording if threshold is crossed.
 * @start_consec_missed_bcon: start recording if threshold is crossed.
 * @start_consec_missed_bcon_since_rx: start recording if threshold is crossed.
 * @reserved1: reserved
 * @reserved2: reserved
 */
struct iwl_fw_dbg_trigger_missed_bcon {
    __le32 stop_consec_missed_bcon;
    __le32 stop_consec_missed_bcon_since_rx;
    __le32 reserved2[2];
    __le32 start_consec_missed_bcon;
    __le32 start_consec_missed_bcon_since_rx;
    __le32 reserved1[2];
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_cmd - configures trigger for messages from FW.
 * cmds: the list of commands to trigger the collection on
 */
struct iwl_fw_dbg_trigger_cmd {
    struct cmd {
        u8 cmd_id;
        u8 group_id;
    } /*__packed*/ cmds[16];
};// __packed;

/**
 * iwl_fw_dbg_trigger_stats - configures trigger for statistics
 * @stop_offset: the offset of the value to be monitored
 * @stop_threshold: the threshold above which to collect
 * @start_offset: the offset of the value to be monitored
 * @start_threshold: the threshold above which to start recording
 */
struct iwl_fw_dbg_trigger_stats {
    __le32 stop_offset;
    __le32 stop_threshold;
    __le32 start_offset;
    __le32 start_threshold;
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_low_rssi - trigger for low beacon RSSI
 * @rssi: RSSI value to trigger at
 */
struct iwl_fw_dbg_trigger_low_rssi {
    __le32 rssi;
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_mlme - configures trigger for mlme events
 * @stop_auth_denied: number of denied authentication to collect
 * @stop_auth_timeout: number of authentication timeout to collect
 * @stop_rx_deauth: number of Rx deauth before to collect
 * @stop_tx_deauth: number of Tx deauth before to collect
 * @stop_assoc_denied: number of denied association to collect
 * @stop_assoc_timeout: number of association timeout to collect
 * @stop_connection_loss: number of connection loss to collect
 * @start_auth_denied: number of denied authentication to start recording
 * @start_auth_timeout: number of authentication timeout to start recording
 * @start_rx_deauth: number of Rx deauth to start recording
 * @start_tx_deauth: number of Tx deauth to start recording
 * @start_assoc_denied: number of denied association to start recording
 * @start_assoc_timeout: number of association timeout to start recording
 * @start_connection_loss: number of connection loss to start recording
 */
struct iwl_fw_dbg_trigger_mlme {
    u8 stop_auth_denied;
    u8 stop_auth_timeout;
    u8 stop_rx_deauth;
    u8 stop_tx_deauth;
    
    u8 stop_assoc_denied;
    u8 stop_assoc_timeout;
    u8 stop_connection_loss;
    u8 reserved;
    
    u8 start_auth_denied;
    u8 start_auth_timeout;
    u8 start_rx_deauth;
    u8 start_tx_deauth;
    
    u8 start_assoc_denied;
    u8 start_assoc_timeout;
    u8 start_connection_loss;
    u8 reserved2;
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_txq_timer - configures the Tx queue's timer
 * @command_queue: timeout for the command queue in ms
 * @bss: timeout for the queues of a BSS (except for TDLS queues) in ms
 * @softap: timeout for the queues of a softAP in ms
 * @p2p_go: timeout for the queues of a P2P GO in ms
 * @p2p_client: timeout for the queues of a P2P client in ms
 * @p2p_device: timeout for the queues of a P2P device in ms
 * @ibss: timeout for the queues of an IBSS in ms
 * @tdls: timeout for the queues of a TDLS station in ms
 */
struct iwl_fw_dbg_trigger_txq_timer {
    __le32 command_queue;
    __le32 bss;
    __le32 softap;
    __le32 p2p_go;
    __le32 p2p_client;
    __le32 p2p_device;
    __le32 ibss;
    __le32 tdls;
    __le32 reserved[4];
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_time_event - configures a time event trigger
 * time_Events: a list of tuples <id, action_bitmap>. The driver will issue a
 *	trigger each time a time event notification that relates to time event
 *	id with one of the actions in the bitmap is received and
 *	BIT(notif->status) is set in status_bitmap.
 *
 */
struct iwl_fw_dbg_trigger_time_event {
    struct {
        __le32 id;
        __le32 action_bitmap;
        __le32 status_bitmap;
    } /*__packed*/ time_events[16];
};// __packed;

/**
 * struct iwl_fw_dbg_trigger_ba - configures BlockAck related trigger
 * rx_ba_start: tid bitmap to configure on what tid the trigger should occur
 *	when an Rx BlockAck session is started.
 * rx_ba_stop: tid bitmap to configure on what tid the trigger should occur
 *	when an Rx BlockAck session is stopped.
 * tx_ba_start: tid bitmap to configure on what tid the trigger should occur
 *	when a Tx BlockAck session is started.
 * tx_ba_stop: tid bitmap to configure on what tid the trigger should occur
 *	when a Tx BlockAck session is stopped.
 * rx_bar: tid bitmap to configure on what tid the trigger should occur
 *	when a BAR is received (for a Tx BlockAck session).
 * tx_bar: tid bitmap to configure on what tid the trigger should occur
 *	when a BAR is send (for an Rx BlocAck session).
 * frame_timeout: tid bitmap to configure on what tid the trigger should occur
 *	when a frame times out in the reodering buffer.
 */
struct iwl_fw_dbg_trigger_ba {
    __le16 rx_ba_start;
    __le16 rx_ba_stop;
    __le16 tx_ba_start;
    __le16 tx_ba_stop;
    __le16 rx_bar;
    __le16 tx_bar;
    __le16 frame_timeout;
};// __packed;
#pragma options align=reset

/*
 * new TLV uCode file layout
 *
 * The new TLV file format contains TLVs, that each specify
 * some piece of data.
 */

enum iwl_ucode_tlv_type {
    IWL_UCODE_TLV_INVALID		= 0, /* unused */
    IWL_UCODE_TLV_INST		= 1,
    IWL_UCODE_TLV_DATA		= 2,
    IWL_UCODE_TLV_INIT		= 3,
    IWL_UCODE_TLV_INIT_DATA		= 4,
    IWL_UCODE_TLV_BOOT		= 5,
    IWL_UCODE_TLV_PROBE_MAX_LEN	= 6, /* a u32 value */
    IWL_UCODE_TLV_PAN		= 7,
    IWL_UCODE_TLV_RUNT_EVTLOG_PTR	= 8,
    IWL_UCODE_TLV_RUNT_EVTLOG_SIZE	= 9,
    IWL_UCODE_TLV_RUNT_ERRLOG_PTR	= 10,
    IWL_UCODE_TLV_INIT_EVTLOG_PTR	= 11,
    IWL_UCODE_TLV_INIT_EVTLOG_SIZE	= 12,
    IWL_UCODE_TLV_INIT_ERRLOG_PTR	= 13,
    IWL_UCODE_TLV_ENHANCE_SENS_TBL	= 14,
    IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
    IWL_UCODE_TLV_WOWLAN_INST	= 16,
    IWL_UCODE_TLV_WOWLAN_DATA	= 17,
    IWL_UCODE_TLV_FLAGS		= 18,
    IWL_UCODE_TLV_SEC_RT		= 19,
    IWL_UCODE_TLV_SEC_INIT		= 20,
    IWL_UCODE_TLV_SEC_WOWLAN	= 21,
    IWL_UCODE_TLV_DEF_CALIB		= 22,
    IWL_UCODE_TLV_PHY_SKU		= 23,
    IWL_UCODE_TLV_SECURE_SEC_RT	= 24,
    IWL_UCODE_TLV_SECURE_SEC_INIT	= 25,
    IWL_UCODE_TLV_SECURE_SEC_WOWLAN	= 26,
    IWL_UCODE_TLV_NUM_OF_CPU	= 27,
    IWL_UCODE_TLV_CSCHEME		= 28,
    IWL_UCODE_TLV_API_CHANGES_SET	= 29,
    IWL_UCODE_TLV_ENABLED_CAPABILITIES	= 30,
    IWL_UCODE_TLV_N_SCAN_CHANNELS		= 31,
    IWL_UCODE_TLV_PAGING		= 32,
    IWL_UCODE_TLV_SEC_RT_USNIFFER	= 34,
    IWL_UCODE_TLV_SDIO_ADMA_ADDR	= 35,
    IWL_UCODE_TLV_FW_VERSION	= 36,
    IWL_UCODE_TLV_FW_DBG_DEST	= 38,
    IWL_UCODE_TLV_FW_DBG_CONF	= 39,
    IWL_UCODE_TLV_FW_DBG_TRIGGER	= 40,
    IWL_UCODE_TLV_FW_GSCAN_CAPA	= 50,
};

struct iwl_ucode_tlv {
    __le32 type;		/* see above */
    __le32 length;		/* not including type/length fields */
    u8 data[0];
};

struct iwl_tlv_ucode_header {
    /*
     * The TLV style ucode header is distinguished from
     * the v1/v2 style header by first four bytes being
     * zero, as such is an invalid combination of
     * major/minor/API/serial versions.
     */
    __le32 zero;
    __le32 magic;
    u8 human_readable[FW_VER_HUMAN_READABLE_SZ];
    /* major/minor/API/serial or major in new format */
    __le32 ver;
    __le32 build;
    __le64 ignore;
    /*
     * The data contained herein has a TLV layout,
     * see above for the TLV header and types.
     * Note that each TLV is padded to a length
     * that is a multiple of 4 for alignment.
     */
    u8 data[0];
};

/*
 * ucode TLVs
 *
 * ability to get extension for: flags & capabilities from ucode binaries files
 */
#pragma pack(1)
struct iwl_ucode_api {
    __le32 api_index;
    __le32 api_flags;
};// __packed;

struct iwl_ucode_capa {
    __le32 api_index;
    __le32 api_capa;
};// __packed;
#pragma options align=reset

/**
 * enum iwl_ucode_tlv_flag - ucode API flags
 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 *	was a separate TLV but moved here to save space.
 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behavior on hidden SSID,
 *	treats good CRC threshold as a boolean
 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
 * @IWL_UCODE_TLV_FLAGS_DW_BC_TABLE: The SCD byte count table is in DWORDS
 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: This uCode image supports uAPSD
 * @IWL_UCODE_TLV_FLAGS_SHORT_BL: 16 entries of black list instead of 64 in scan
 *	offload profile config command.
 * @IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS: D3 image supports up to six
 *	(rather than two) IPv6 addresses
 * @IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID: not sending a probe with the SSID element
 *	from the probe request template.
 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL: new NS offload (small version)
 * @IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE: new NS offload (large version)
 * @IWL_UCODE_TLV_FLAGS_P2P_PM: P2P client supports PM as a stand alone MAC
 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_DCM: support power save on BSS station and
 *	P2P client interfaces simultaneously if they are in different bindings.
 * @IWL_UCODE_TLV_FLAGS_P2P_BSS_PS_SCM: support power save on BSS station and
 *	P2P client interfaces simultaneously if they are in same bindings.
 * @IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT: General support for uAPSD
 * @IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD: P2P client supports uAPSD power save
 * @IWL_UCODE_TLV_FLAGS_BCAST_FILTERING: uCode supports broadcast filtering.
 * @IWL_UCODE_TLV_FLAGS_GO_UAPSD: AP/GO interfaces support uAPSD clients
 * @IWL_UCODE_TLV_FLAGS_EBS_SUPPORT: this uCode image supports EBS.
 */
enum iwl_ucode_tlv_flag {
    IWL_UCODE_TLV_FLAGS_PAN			= BIT(0),
    IWL_UCODE_TLV_FLAGS_NEWSCAN		= BIT(1),
    IWL_UCODE_TLV_FLAGS_MFP			= BIT(2),
    IWL_UCODE_TLV_FLAGS_P2P			= BIT(3),
    IWL_UCODE_TLV_FLAGS_DW_BC_TABLE		= BIT(4),
    IWL_UCODE_TLV_FLAGS_SHORT_BL		= BIT(7),
    IWL_UCODE_TLV_FLAGS_D3_6_IPV6_ADDRS	= BIT(10),
    IWL_UCODE_TLV_FLAGS_NO_BASIC_SSID	= BIT(12),
    IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_SMALL	= BIT(15),
    IWL_UCODE_TLV_FLAGS_NEW_NSOFFL_LARGE	= BIT(16),
    IWL_UCODE_TLV_FLAGS_P2P_PM		= BIT(21),
    IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_DCM	= BIT(22),
    IWL_UCODE_TLV_FLAGS_BSS_P2P_PS_SCM	= BIT(23),
    IWL_UCODE_TLV_FLAGS_UAPSD_SUPPORT	= BIT(24),
    IWL_UCODE_TLV_FLAGS_EBS_SUPPORT		= BIT(25),
    IWL_UCODE_TLV_FLAGS_P2P_PS_UAPSD	= BIT(26),
    IWL_UCODE_TLV_FLAGS_BCAST_FILTERING	= BIT(29),
    IWL_UCODE_TLV_FLAGS_GO_UAPSD		= BIT(30),
};

enum iwl_fw_phy_cfg {
    FW_PHY_CFG_RADIO_TYPE_POS = 0,
    FW_PHY_CFG_RADIO_TYPE = 0x3 << FW_PHY_CFG_RADIO_TYPE_POS,
    FW_PHY_CFG_RADIO_STEP_POS = 2,
    FW_PHY_CFG_RADIO_STEP = 0x3 << FW_PHY_CFG_RADIO_STEP_POS,
    FW_PHY_CFG_RADIO_DASH_POS = 4,
    FW_PHY_CFG_RADIO_DASH = 0x3 << FW_PHY_CFG_RADIO_DASH_POS,
    FW_PHY_CFG_TX_CHAIN_POS = 16,
    FW_PHY_CFG_TX_CHAIN = 0xf << FW_PHY_CFG_TX_CHAIN_POS,
    FW_PHY_CFG_RX_CHAIN_POS = 20,
    FW_PHY_CFG_RX_CHAIN = 0xf << FW_PHY_CFG_RX_CHAIN_POS,
};

/*
 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
 */
#pragma pack(1)
struct fw_sec_parsing {
    __le32 offset;
    const u8 data[];
};// __packed;

/**
 * struct iwl_tlv_calib_data - parse the default calib data from TLV
 *
 * @ucode_type: the uCode to which the following default calib relates.
 * @calib: default calibrations.
 */
struct iwl_tlv_calib_data {
    __le32 ucode_type;
    struct iwl_tlv_calib_ctrl calib;
};// __packed;

/**
 * struct iwl_fw_cipher_scheme - a cipher scheme supported by FW.
 * @cipher: a cipher suite selector
 * @flags: cipher scheme flags (currently reserved for a future use)
 * @hdr_len: a size of MPDU security header
 * @pn_len: a size of PN
 * @pn_off: an offset of pn from the beginning of the security header
 * @key_idx_off: an offset of key index byte in the security header
 * @key_idx_mask: a bit mask of key_idx bits
 * @key_idx_shift: bit shift needed to get key_idx
 * @mic_len: mic length in bytes
 * @hw_cipher: a HW cipher index used in host commands
 */
struct iwl_fw_cipher_scheme {
    __le32 cipher;
    u8 flags;
    u8 hdr_len;
    u8 pn_len;
    u8 pn_off;
    u8 key_idx_off;
    u8 key_idx_mask;
    u8 key_idx_shift;
    u8 mic_len;
    u8 hw_cipher;
};// __packed;

/**
 * struct iwl_fw_cscheme_list - a cipher scheme list
 * @size: a number of entries
 * @cs: cipher scheme entries
 */
struct iwl_fw_cscheme_list {
    u8 size;
    struct iwl_fw_cipher_scheme cs[];
};// __packed;

/**
 * struct iwl_fw_dbg_conf_tlv - a TLV that describes a debug configuration.
 * @id: conf id
 * @usniffer: should the uSniffer image be used
 * @num_of_hcmds: how many HCMDs to send are present here
 * @hcmd: a variable length host command to be sent to apply the configuration.
 *	If there is more than one HCMD to send, they will appear one after the
 *	other and be sent in the order that they appear in.
 * This parses IWL_UCODE_TLV_FW_DBG_CONF. The user can add up-to
 * %FW_DBG_CONF_MAX configuration per run.
 */
struct iwl_fw_dbg_conf_tlv {
    u8 id;
    u8 usniffer;
    u8 reserved;
    u8 num_of_hcmds;
    struct iwl_fw_dbg_conf_hcmd hcmd;
};// __packed;

/**
 * struct iwl_fw_gscan_capabilities - gscan capabilities supported by FW
 * @max_scan_cache_size: total space allocated for scan results (in bytes).
 * @max_scan_buckets: maximum number of channel buckets.
 * @max_ap_cache_per_scan: maximum number of APs that can be stored per scan.
 * @max_rssi_sample_size: number of RSSI samples used for averaging RSSI.
 * @max_scan_reporting_threshold: max possible report threshold. in percentage.
 * @max_hotlist_aps: maximum number of entries for hotlist APs.
 * @max_significant_change_aps: maximum number of entries for significant
 *	change APs.
 * @max_bssid_history_entries: number of BSSID/RSSI entries that the device can
 *	hold.
 */
struct iwl_fw_gscan_capabilities {
    __le32 max_scan_cache_size;
    __le32 max_scan_buckets;
    __le32 max_ap_cache_per_scan;
    __le32 max_rssi_sample_size;
    __le32 max_scan_reporting_threshold;
    __le32 max_hotlist_aps;
    __le32 max_significant_change_aps;
    __le32 max_bssid_history_entries;
};// __packed;
#pragma options align=reset

#endif /* firmware_defs_h */
